XPSWMM/XPStorm Conversion Notes (InfoWorks)
XPSWMM/XPStorm network data can be imported from XPX files to InfoWorks networks.
This topic contains conversion details regarding the import of the files to ICM InfoWorks network objects.
Network Objects
Network data can be imported from XPX files to various InfoWorks network objects in ICM. The applicable conversion information is contained in the relevant sections in this topic.
Object Category |
Object Parameters |
Conversion Notes |
---|---|---|
Nodes | Node | See below |
Links | Conduit | See below |
Shape | See below | |
Orifice | See below | |
Sluice | See below | |
Weir | See below | |
Pump | See below | |
Head discharge table | See below | |
Channel | See below | |
Channel shape | See below | |
Flap valve | See below | |
User-defined control | See below | |
Subcatchments | Subcatchment | See below |
Runoff surface | See below | |
Land use | See below | |
RTK hydrograph | See below | |
Build-up/wash off land use | See below | |
Polygons | Polygons | See below |
Mesh zones | See below | |
2D zones | See below | |
Mesh level zones | See below | |
Roughness zones | See below | |
IC zone - hydraulic (2D) | See below | |
Lines | 2D boundary | See below |
Nodes
The following fields in an XPX file are imported into a Node object in an ICM InfoWorks network:
XPX Field | XPX Description | InfoWorks ICM Data Field | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
node_name | Node name |
Node ID |
Imported with the XPX node name. However, for Node type set to Outfall, which was created for XPX GATE =1, the name of the node will be the same as GATE=1 but with a ! appended to the end of it. And for or Node type set to Manhole, which was created for XPX CNTLW =1, the name of the node will be the same as the DS node ID for the weir it was created for but with a ! appended to the end of it. See the description of Node type below for further information. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NODST | Storage Node Data Flag | Node type |
Set to Manhole if NODST = 0 Set to Storage if NODST = 1 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FLGOUTF | Outfall Flag |
Set to Manhole if FLGOUTF = 0 Set to Outfall if FLGOUTF = 1 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GATE | Tide Gate Flag |
Set to Manhole if GATE = 1 Set to Outfall if GATE = 0 If GATE = 1, the data is imported as an ICM Manhole type of node and ICM also creates a new node of type Outfall which has the same properties as the imported GATE = 1 node except for the Node ID (see above) and the Y coordinate (see below). A Flap Valve type of link is created to connect the imported XPX GATE =1 Manhole node and the newly created Outfall node. See the Flap Valve section for further information. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CNTLW | Reverse Flow Eliminated using Flap Gates |
For data imported as Weirs in ICM. If CNTLW = 1, ICM creates a node of type Manhole that has the same properties as the DS node ID of the weir it was created for except for the Node ID (see above) and the Y coordinate (see below). A Flap Valve type of link is also created to connect the node of the imported CNTLW = 1 weir and the newly created node. See the Weir section and Flap Valve section for further information. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
x | x | x | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
y | y | y |
For Node type set to Outfall that was created for XPX GATE =1, the Y coordinate of the newly created node is increased by 1 more than the Y coordinate of GATE =1. See the description of Node type above. For Node type set to Manhole that was created for XPX CNTLW =1, the Y coordinate of the newly created node is increased by 1 more than the Y coordinate of CNTLW =1. See the description of Node type above. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Z | Invert Elevation | Chamber floor level | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GRELEV | Ground Elevation (Spill Crest) | Ground level | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Flood level | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CNTLJD | Junction Default Flag | Chamber plan area |
If CNTLJD = 1 and AMEN > 0, the Chamber plan area is set to the value imported for AMEN. If AMEN CNTLJD = 0, the Chamber plan area is set to the XPSWMM default value of 1.1674196 m2 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AMEN | Default Junction Surface Area | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CNTLJD | Junction Default Flag | Shaft plan area |
If CNTLJD = 1 and AMEN > 0, the Shaft plan area is set to the value imported for AMEN. If AMEN CNTLJD = 0, the Shaft plan area is set to the XPSWMM default value of 1.1674196 m2 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AMEN | Default Junction Surface Area | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EPA_ALLOW_PONDING | Flood type |
Set to Stored if EPA_ALLOW_PONDING = 1 Set to Lost if EPA_ALLOW_PONDING = 0 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CNTLS | Storage Method Stepwise - Depth | Storage array |
Applicable for Node type set to Storage. The values for the Level and Area fields in ICM are imported as follows:
CNTLS = 1 or Constant:
*Unless the imported Ground Elevation(GRELEV) – Invert Level(Z) < 1.0 then the Max Depth will be imported as equal to the difference between Ground Elevation and Invert Level.
CNTLS = 2 (Power Function): 16 Level values will be assigned in the storage array that are linearly interpolated between the imported Invert Elevation(Z) value and the imported Ground Elevation(GRELEV) value. 16 Area values will also be assigned to the storage area which are calculated using a CONST x DepthEXPO, where Depth is the Level – Invert Elevation (Z). An example is shown below where the value for the imported Invert Elevation(Z) is 2 and the imported Ground Elevation(GRELEV) value is 10. The corresponding linear interpolated values for each step are shown in the Level column and the calculated area in the Area column.
However, if the imported values for CONST = 0 or Ground elevation(GRELEV) – Invert Elevation(Z) = 0, the first row of the storage array will be set as follows:
If CONST = 0 but Ground Elevation(GRELEV) – Invert Elevation(Z) is not equal 0, the storage array will be set will be as follows:
CNTSL = 3 (Stepwise Linear) Level values are imported as the values of QCURRL + Invert Elevation (Z) and the Areavalues are imported as the values QCURA converted to m2 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QCURRL | Power Function Coefficient | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GRELEV | Ground Elevation (Spill Crest) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Z | Invert Elevation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ASTORE | Constant Area Storage | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CONST | Power Function Coefficient | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EXPO | Power Function Exponent | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Y0 | Initial Depth | User number 1 | For Node type set to Manhole or Storage | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NTIDE | Type of Outlet Control | User number 1 |
For Node type set to Outfall If NTIDE = 2, the 'value' of A1A is imported to User number 1 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A1A | Outlet Control Backwater | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NTIDE | Type of Outlet Control | User text 1 | If NTIDE = 3 or 4, User text 1 is set to <node name>_TS | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
User text 2 | If NTIDE = 5, User text 2 is set to <node name>_TS |
Links
Data from an XPX file is imported to the following types of Link objects in an ICM InfoWorks network.
Conduits
The following fields in an XPX file are imported as a Conduit type of link object in an ICM InfoWorks network if the shape of a conduit is not 'Natural' in the XPX file. Natural shaped conduits from XPSWMM/XPStorm are imported as Channels in ICM.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
node_from | US Node | US node ID | |||||||||||||||||||||||||||||||||||||||
node_to | DS Node | DS Node ID | |||||||||||||||||||||||||||||||||||||||
link_type | Link type | Link type | Set to Conduit | ||||||||||||||||||||||||||||||||||||||
link_name | Link name | Asset ID | |||||||||||||||||||||||||||||||||||||||
length | LEN | Length | |||||||||||||||||||||||||||||||||||||||
ZP1 | Upstream Invert Elevation | US invert level | |||||||||||||||||||||||||||||||||||||||
ZP2 | Downstream Invert Elevation | DS invert level | |||||||||||||||||||||||||||||||||||||||
NKLASS | Shape ID |
The table below lists the shapes from the XPX file that are imported as a standard InfoWorks ICM shape:
The table below lists the special shapes from the XPX file that are imported as pre-defined shapes in ICM.
The table below lists the shapes from the XPX file that are imported as ICM user-defined shapes.
See the Shape section for further import information. |
|||||||||||||||||||||||||||||||||||||||
DEEP | Diameter | Height |
|
||||||||||||||||||||||||||||||||||||||
Width | |||||||||||||||||||||||||||||||||||||||||
DEEP | Diameter | Height | For Shape ID set to RECT, and for a Parabolic type of user-defined shape. | ||||||||||||||||||||||||||||||||||||||
WIDE | Bottom Width | Width | |||||||||||||||||||||||||||||||||||||||
DEEP | Diameter | Height | For a Trapezoid type of user-defined shape. Width is calculated as: WIDE + (TTHETA * DEEP) + (TPHI * DEEP) |
||||||||||||||||||||||||||||||||||||||
WIDE | Bottom Width | Width | |||||||||||||||||||||||||||||||||||||||
DEEP | Diameter | ||||||||||||||||||||||||||||||||||||||||
TTHETA | Left Hand Side Slope | ||||||||||||||||||||||||||||||||||||||||
TPHI | Right Hand Side Slope | ||||||||||||||||||||||||||||||||||||||||
DEP | Depth | Height |
For an imported User Defined type of user-defined shape. Height is imported as the maximum depth from all values in DEP fields. Width is imported as the maximum width from all values in SW fields. |
||||||||||||||||||||||||||||||||||||||
SW | Surface Width | Width | |||||||||||||||||||||||||||||||||||||||
DEEP | Diameter | Height | |||||||||||||||||||||||||||||||||||||||
WIDE | With | Width | Imported for ModBasketHandle, RecTriangular or RectRound user-defined type of shapes. | ||||||||||||||||||||||||||||||||||||||
ROUGH | Roughness | Bottom roughness Manning's N | Imported for conduits with an XPSWMM/XPStorm User Defined type of shape. | ||||||||||||||||||||||||||||||||||||||
ROUGH | Roughness | Top roughness Manning's N | |||||||||||||||||||||||||||||||||||||||
CF | Conduit Factors | DS headloss type | Set to Fixed Only applicable when Conduit Factors are enabled in the XPX file. |
||||||||||||||||||||||||||||||||||||||
CF | Conduit Factors | US headloss coefficient |
Imported if Conduit Factors are enabled. If Loss Type = 0(Energy Loss Coefficient), US headloss coefficient is set to the value of the imported Entrance Loss (PLC). If Loss Type = 1(Pressure Change Coefficient), the US headloss coefficient is set to the value of: KU + KUCONST * KUCONST - 1 |
||||||||||||||||||||||||||||||||||||||
LOSSTYPE | Loss Type | ||||||||||||||||||||||||||||||||||||||||
PLC | Entrance Loss | ||||||||||||||||||||||||||||||||||||||||
KU | Pressure Change Coefficient KU | ||||||||||||||||||||||||||||||||||||||||
KUCONST | Pressure Change Coefficient B | ||||||||||||||||||||||||||||||||||||||||
CF | Conduit Factors | DS headloss coefficient |
Imported if Conduit Factors are enabled. If Lost Type = 0(Energy Loss Coefficient), DS headloss coefficient is set to the value of the imported Exit Loss (GEOFF ). If Loss Type = 1(Pressure Change Coefficient), the value of the dS headloss coefficient is set to 0.0 |
||||||||||||||||||||||||||||||||||||||
LOSSTYPE | Loss Type | ||||||||||||||||||||||||||||||||||||||||
GEOFF | Exit Loss | ||||||||||||||||||||||||||||||||||||||||
Q0 | Initial Flow | User number 1 |
Shape
XPSWMM/XPStorm Trapezoidal, Parabolic, RectRound, ModBasketHandle, RecTriangular and User Defined conduit shapes are imported as Shape types of link objects in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Shape ID | <linkname>_shape | ||||||||||||||||||||
Shape type |
Set to Asymmetric for Trapezoidal. Set to Symmetric for Parabolic, User Defined, ModBasketHandle, RecTriangular, and RectRound. |
||||||||||||||||||||
Description | Imported as type of shape - Trapezoidal, Parabolic, User Defined, XPSWMM Rectangle rounded bottom, XPSWMM RectTriangular and XPSWMM Mod Basket Handle | ||||||||||||||||||||
WIDE | Bottom Width | Geometry |
For Trapezoidal:
|
||||||||||||||||||
DEEP | Diameter | ||||||||||||||||||||
TTHETA | Left Hand Side Slope | ||||||||||||||||||||
TPHI | Right Hand Side Slope | ||||||||||||||||||||
WIDE | Bottom Width | Geometry |
For Parabolic:
|
||||||||||||||||||
DEEP | Diameter | ||||||||||||||||||||
PTHETA | Power Function Channel Exponent | ||||||||||||||||||||
DEP | Depth | Geometry |
For User Defined:
|
||||||||||||||||||
SW | Surface Width | ||||||||||||||||||||
WIDE | Bottom Width | Geometry |
For ModBasketHandle:
|
||||||||||||||||||
DEEP | Diameter | ||||||||||||||||||||
WIDE | Bottom Width | Geometry |
For RecTriangular:
|
||||||||||||||||||
DEEP | Diameter | ||||||||||||||||||||
AFULL | Height of Rectangle | ||||||||||||||||||||
WIDE | Bottom Width | Geometry |
For RectRound:
1st - 15th element: [element count - 1 / DEEP, calculated width based on the dimensions]
16th element: [Radius, 1.0] where: Radius = WIDE2 / (8.0 * (DEEP - AFULL)) + (WIDE - AFULL) / 2.0
17th element: [1.0, 1.0]
18th element: [1.0, 0.0] |
||||||||||||||||||
DEEP | Diameter | ||||||||||||||||||||
AFULL | Height of Rectangle | ||||||||||||||||||||
Normalised | Checked for shape type Trapezoidal, Parabolic, User Defined, RecTriangular |
Orifice
The following fields in an XPX file are imported as a Orifice type of ancillary link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
ORIFNAME | Orifice name | Asset ID | |
ISQRND | Orifice Shape | Link type |
If XPX ISQRND = 0 (Circular), the Link type is set to Orific in ICM. |
ISQRND | Orifice Shape | Diameter |
If XPX ISQRND = 0 (Circular), the Diameter of the orifice in ICM is imported as: √((4 x AORIF) / π) |
AORIF | Orifice Area | ||
ZP | Orifice Invert Elevation | Invert level | |
CORIF | Orifice Discharge Coefficient | Discharge coefficient |
The Discharge coefficient in ICM is imported as: CORIF x √2 |
Sluice
The following fields in an XPX file are imported as a Sluice type of ancillary link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
ORIFNAME | Orifice name | Asset ID | |
ISQRND | Orifice Shape | Link type |
If XPX ISQRND = 1 (Rectangular), the Link type is set to Sluice in ICM. |
ISQRND | Orifice Shape | Width |
If XPX ISQRND = 1 (Rectangular), the Width of a sluice in ICM is imported as: AORIF / DORIF |
AORIF | Orifice Area | ||
DORIF | Orifice Height | ||
ISQRND | Orifice Shape | Opening height |
If XPX ISQRND = 1 (Rectangular), the Opening height is set to the imported XPX DORIF value. |
DORIF | Orifice Height | ||
ZP | Orifice Invert Elevation | Invert level | |
CORIF | Orifice Discharge Coefficient | Discharge coefficient |
The Discharge coefficient in ICM is imported as: CORIF x √2 |
User-defined control
The following fields in an XPX file are imported as a User-defined control type of ancillary link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
SPECNAME | Diversion Name | Asset ID | Only imported as a user-defined contol object if XPX SPECDIV = 5 (Internal Rating Curve). |
Link type |
The Link type is set to Compnd in ICM. |
||
Z (US node) | Initial level |
|
|
Head discharge table | A Head discharge table object is added in ICM. See below for further information. |
Weir
The following fields in an XPX file are imported as a Weir type of ancillary link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
node_from | US Node | US node ID | |
node_to | DS Node | DS node ID | |
link_type | Link type | Link type | Set to Weir |
link_name | Link name | Asset ID | |
Z (US node) | Invert Elevation | Crest |
The Crest in ICM is imported as YCREST - Z (US node) If the XPX file is in US units, it is converted using the following formula: Offset = (YCREST - Z) x 0.3048 ->ft to m Invert = (Offset5/3)2/3 Crest = Invert * 3.28084 -> m to ft |
YCREST | Crest | ||
YTOP | Crown | Roof height |
The Roof height in ICM is imported as YTOP - YCREST |
YCREST | Crest | ||
WLEN | Weir Length | Width | |
COEFF | Discharge coefficient | Discharge coefficient |
The Discharge coefficient in ICM is imported as COEFF * √Gravity |
CNTLW | Reverse Flow Eliminated using Flap Gates | If CNTLW = 1. A manhole type of node is created in ICM. This node will have the same properties as the DS node ID of the weir it was created for except the Y coordinate is increased by 1. The newly created node becomes the DS node ID of the weir, and a Flap Valve type of link is created to connect the node of the imported XPX CNTLW = 1 and the newly created node. See the Nodes and the Flap Valve sections for further information. |
Pump
The following fields in an XPX file are imported as a Pump type of ancillary link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
node_from | US Node | US node ID | |
node_to | DS Node | DS Node ID | |
link_name | Link name | Asset ID | |
IPTYP | Pump Rated By | Link type |
If IPTYP = Well Volume or Depth in Node, Link type is set to FIXPMP If IPTYP = Dynamic Head, Link type is set to ROTPMP |
Z (US node) | Invert Elevation (US node) | Switch on level |
If IPTYP = Well Volume or Depth in Node, and if PON > Level, then the Switch on level is set to the value of PON; otherwise, the Switch on level is set to the value of Level. Where Level is the:
If IPTYP = Dynamic Head, the Switch on level is set to the value of PON + Level. Where Level is the:
|
PON | Pump Starts Elevation | ||
IPTYP | Pump Rated By | ||
PSEL | Pump Rating | ||
PRATEX | Pump Flow Rate | ||
Z (US node) | Invert Elevation (US node) | Switch off level |
If IPTYP = Well Volume or Depth in Node, and if POFF > Level then the Switch off level is set to the value of POFF; otherwise, the Switch off level is set to the value of Level. Where Level is the:
If IPTYP = Dynamic Head, the Switch off level is set to the value of POFF + Level. Where Level is the:
|
PON | Pump Stops Elevation | ||
IPTYP | Pump Rated By | ||
PRATEY | Node Depth | Discharge |
If IPTYP = Well Volume or Depth in Node. Discharge = 1st element of PRATEY |
Dynamic Head | |||
Well Volume | |||
Head discharge table |
If IPTYPE = Dynamic Head, a Head discharge object is added in ICM. See below for further information. |
||
User text 1 | OFF |
Head discharge table
If IPTYPE = Dynamic Head in the XPX file or if data has been imported from the XPX file as a User-defined control object (see above), the following fields are imported as a Head discharge table type of ancillary link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Head discharge ID |
The format used for the Head discharge ID is: <US Node name>.<suffix> |
||||||||||||||||||||||
Head discharge power table |
If IPTYPE = Dynamic Head, the following fields in the XPX file are imported to the Head discharge power table :
If a User-defined Control object has been added to ICM, the following fields in the XPX file are imported to the Head discharge power table :
|
Channel
The following fields in an XPX file for XPSWMM/XPStorm 'Natural' shaped conduits are imported as a Channel type of link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
node_from | US Node | US node ID | |
node_to | DS Node | DS Node ID | |
NKLASS | Shape type | Link type | Set to Channel for XPSWMM/XPStorm natural conduits. |
link_name | Link name | Asset ID | |
Shape ID | The shape of channel is imported as a channel shape (see the Channel shape section) | ||
ZP1 | Upstream Invert Elevation | US invert level | |
ZP2 | Downstream Invert Elevation | DS invert level | |
CF | Conduit Factors | DS headloss type | Set to Fixed Only applicable when Conduit Factors are enabled in the XPX file. |
CF | Conduit Factors | US headloss coefficient |
Imported if Conduit Factors are enabled. If Loss Type = 0(Energy Loss Coefficient), US headloss coefficient is set to the value of the imported Entrance Loss (PLC). If Loss Type = 1(Pressure Change Coefficient), the US headloss coefficient is set to the value of: KU + KUCONST * KUCONST - 1 |
LOSSTYPE | Loss Type | ||
PLC | Entrance Loss | ||
KU | Pressure Change Coefficient KU | ||
KUCONST | Pressure Change Coefficient B | ||
CF | Conduit Factors | DS headloss coefficient |
Imported if Conduit Factors are enabled. If Lost Type = 0(Energy Loss Coefficient), DS headloss coefficient is set to the value of the imported Exit Loss (GEOFF ). If Loss Type = 1(Pressure Change Coefficient), the value of the dS headloss coefficient is set to 0.0 |
LOSSTYPE | Loss Type | ||
GEOFF | Exit Loss |
Channel shape
The following fields in an XPX file are imported as a Channel shape type of link object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NATS_SHAPE | Shape | Shape ID | |||||||||||||||||||||||||||||||
Roughness type | Set to N (Manning's n ) | ||||||||||||||||||||||||||||||||
Channel Profile |
|
Flap valve
A Flap value type of ancillary link object is created in an ICM InfoWorks network when the value of the XPX GATE field is 1 or the value of the CNTLW field is 1. See the description of Node type in the Nodes section for further information.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
|
Invert level | Set to the value of the imported node's or weir's ground level. | |
|
Diameter | Set to the lesser value of the Height or Width of the upstream conduit of the imported node or weir. |
Subcatchments
Data from an XPX file is imported to the following types Subcatchment objects in an ICM InfoWorks network.
Subcatchment
The following fields in an XPX file are imported as a Subcatchment object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
node_name | Node name | Subcatchment ID |
The format for the name of the imported subcatchment is: <node_name>#<s> |
||||||||||||
s | Subcatchment # | ||||||||||||||
R_REDIR_FLAG | Flow Redirection | Drains to |
Drains to is set to Node on import if the XPX R_REDIR_FLAG = 0 or R_REDIR_FLAG = 1 and R_REDIR_SUBCAT = 6; otherwise Drains to is set to = Subcatchment |
||||||||||||
R_REDIR_SUBCAT | Subcatchment # | ||||||||||||||
node_name | Node name | Node ID |
Imported if Drains to is set to Node on import. If the XPX R_REDIR_FLAG = 0, then Node ID is imported with the XPX Node name. If the XPX R_REDIR_FLAG = 1 and R_REDIR_SUBCAT = 6, the NODE ID is imported with the name of the XPX Runoff Redirection Drain to Node. |
||||||||||||
R_REDIR_FLAG | Flow Redirection | ||||||||||||||
R_REDIR_SUBCAT | Subcatchment # | ||||||||||||||
R_REDIR_NODE | Runoff Redirection Drain to Node | ||||||||||||||
node_name | Node name | To Subcatchment ID |
Imported if Drains to is set to Subcatchment on import. If the XPX R_REDIR_FLAG = 1 and R_REDIR_SUBCAT = 1 to 5, the format for the imported To Subcatchment ID is: <R_REDIR_NODE>#<R_REDIR_SUBCAT> |
||||||||||||
R_REDIR_FLAG | Flow Redirection | ||||||||||||||
R_REDIR_SUBCAT | Subcatchment # | ||||||||||||||
R_REDIR_NODE | Runoff Redirection Drain to Node | ||||||||||||||
R_RAINSEL | Rainfall | Rainfall profile |
If R_RAINSEL is not blank, the Rainfall profile is imported with the name of R_RAINSEL from the XPX file. If R_RAINSEL is blank and R_FGSTORMS is active, the Rainfall profile is imported with the name of the current storm in the XPX file. |
||||||||||||
R_FGSTORMS | |||||||||||||||
R_WAREA | Area | Total area | |||||||||||||
R_WIDTH | Width | Dimension | |||||||||||||
R_WSLOPE | Slope | Slope | |||||||||||||
Build-up/washoff land use |
The values for the Build-up/washoff land use grid are imported as shown below:
|
||||||||||||||
Area measurement type | Set to Percent | ||||||||||||||
R_WIMP | Impervious Percentage | Runoff area 1 (%) |
Imported value calculated as: R_WIMP - (R_WIMP x R_PCTZER / 100) |
||||||||||||
R_PCTZER | Zero Detention (%) Input | ||||||||||||||
R_WIMP | Impervious Percentage | Runoff area 2 (%) |
Imported value calculated as: R_WIMP x R_PCTZER / 100 |
||||||||||||
R_PCTZER | Zero Detention (%) Input | ||||||||||||||
R_WIMP | Impervious Percentage | Runoff area 3 (%) |
Imported value calculated as: 100 - R_WIMP |
||||||||||||
Runoff routed internally (%) | Set to 100 | ||||||||||||||
R_REDIR_TYPE | Runoff Redirection Type | Internal routing |
Internal routing is set as To pervious if the XPX R_REDIR_TYPE = 1 If the XPX R_REDIR_TYPE = 2, Internal routing is set as To impervious Otherwise, Internal routing is set to Direct |
||||||||||||
R_FLAG_RDII | RNF Node Sub-Catchment RDII Flag | RTK hydrograph | Imported if the XPX field, R_FLAG_RDII, is checked. | ||||||||||||
R_RDII_NAME | RDII name | ||||||||||||||
R_FLAG_RDII | RNF Node Sub-Catchment RDII Flag | Contributing area |
Imported if the XPX field, R_FLAG_RDII, is checked. If R_RDII_AREA = 0, then the ICM Contributing area is set to the value of the XPX R_WAREA. Otherwise, the Contributing area is set to the value of R_RDII_SEWER |
||||||||||||
R_RDII_AREA | The type of RDII areas used in a sub-catchment | ||||||||||||||
R_WAREA | Area | ||||||||||||||
R_RDII_SEWER | User-Defined Sewershed Area | ||||||||||||||
R_INFILM | Infiltration Method | Curve number | If the Infiltration Method in the XPX file is set to Curve Number, then the Curve number in ICM is set to the value of SCS_CN | ||||||||||||
SCS_CN | Pervious Area Curve Number | ||||||||||||||
R_CN | Pervious CN | Set to the value of R_CN | |||||||||||||
R_TC | Time of concentration | Time of concentration | |||||||||||||
Unit hydrograph definition | Set to SCS-User-Tc |
Land use
A Land use object in an ICM InfoWorks network is automatically added for each subcatchment in an XPX file that contains an infiltration object. Note that a new Land use object will not be added if there is an existing Land Use object with the identical properties.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
Land use | Land use ID | Each Land use ID generated by ICM is given a numeric ID, starting at 1 and incrementing by 1 for each additional Land use object created by ICM. | |
Description | Assigned a description of SWMM Landuse | ||
Runoff surface 1 |
ID of an impervious surface with initial loss See the Runoff surface section below for more information. |
||
Runoff surface 2 |
ID of an impervious surface without initial loss See the Runoff surface section below for more information. |
||
Runoff surface 3 |
ID of a pervious surface See the Runoff surface section below for more information. |
||
Pollutant index | Set to 1. |
Runoff surface
A Runoff surface object in an ICM InfoWorks network is automatically created for each Runoff Surface (1-3) included in a Land Use object (see above). Note that a new Runoff Surface will not be added if there is an existing Runoff Surface object with the identical properties. If the XPX file being imported contains fields that are relevant to the Runoff Surface object, then these are imported as described below:
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
Runoff surface ID |
Each Runoff surface ID object, generated by ICM, is given a numeric ID, starting at 1 and incrementing by 1 for each additional runoff surface object created. |
||
R_REDIR_TYPE | Runoff Redirection Type | Surface type |
Set to Impervious if R_REDIR_TYPE = 2 Set to Pervious if R_REDIR_TYPE = 1 See the description of Internal routing for ICM subcatchments above. |
R_WIMP | Imper |
Set to Impervious if R_WIMP = 100; otherwise set to Pervious |
|
R_FSCS | Routing Method | Routing model | Set to SCS Unit if R_FSCS = 1; otherwise set to SWMM |
Runoff volume type |
If the Routing model is set to SCS Unit, the Runoff volume type is set to CN |
||
If the Routing model is set to SWMM, the Runoff volume type is set to Fixed for Surface type set to Impervious | |||
R_INFILM | Infiltration Method |
If the Routing model is set to SWMM and the Surface type set to Pervious, and: If the XPX Infiltration Method = Horton, the ICM Runoff volume type is set to HortonSWMM If the XPX Infiltration Method = Green Ampt, the ICM Runoff volume type is set to GreenAmpt |
|
Fixed runoff coefficient |
Set to 1 for Surface type set to Impervious Set to 0 for Surface type set to Pervious |
||
R_WSLOPE | Slope | Ground slope | Set to the value of R_WSLOPE if it is present in the XPX file; otherwise set to 0.0 |
Initial loss type | If the Routing model is set to SWMM, the Initial loss type is set to Abs | ||
R_IA | Initial abstraction | If the Routing model is set to SCS Unit and if the imported XPX file contains a value for R_IA, the Initial loss type is set to Abs if the value of R_IA is 0; for all other values it is set to SCS | |
R_WSTOR1 | Inch (Impervious Area) Input | Initial loss value |
If the Routing model is set to SWMM and: For Surface type set to Impervious, which has initial losses, the Initial loss value is set to the imported XPX R_WSTOR1 value, converted into metres in ICM. For Surface type set to Impervious, which has no initial losses, the Initial loss value is set to 0.0 |
R_WSTOR2 | Inch (Pervious Area) Input |
If the Routing model set to SWMM , and the Surface type is set to Pervious, the Initial loss value is set to the imported XPX R_WSTOR2 value, converted to metres in ICM. |
|
R_IA | Initial abstraction |
If the Routing model set to SCS Unit and the value of R_IA is 1, the value of the Initial loss value is set to the value of R_IADEPTH, converted to metres in ICM. If the value of R_IA is not 1, the Initial loss value is not set. |
|
R_IADEPTH | Initial abstraction depth | ||
R_IA | Initial abstraction | Initial abstraction factor |
Routing model set to SCS Unit and the value of R_IA is 1, the value of the Initial abstraction factor is set to the value of R_IAFRACT. If the value of R_IA is not 1, the Initial abstraction factor is not set. |
R_IAFRACT | Initial abstraction fraction | ||
Runoff routing type | Set to Abs | ||
Runoff routing value | Set to 0, if the Routing model is set to SCS Unit | ||
R_PROUGI | Manning's "n" (Impervious Area) Input |
If the Routing model is set to SWMM, then for Surface type set to Impervious, the Runoff routing value is set to the imported XPX R_PROUGI value. |
|
R_PROUGH | Manning's "n" (Pervious Area) Input |
If the Routing model is set to SWMM, then for Surface type set to Pervious, the Runoff routing value is set to the imported XPX R_PROUGH value. |
|
R_INFILM | Infiltration Method | Initial infiltration |
For Runoff volume type set to HortonSWMM, the Initial infiltration is set to the imported XPX R_WLMAX value. |
R_WLMAX | Max Infiltration Rate Input | ||
R_INFILM | Infiltration Method | Limiting infiltration |
For Runoff volume type set to HortonSWMM, the Limiting infiltration is set to the imported XPX R_WLMIN value. |
R_WLMIN | Min (Asymptotic) Infiltration | ||
R_INFILM | Infiltration Method | Decay factor |
For Runoff volume type set to HortonSWMM, the Decay factor is set to the value of the imported XPX R_DECAY multiplied by 3600 |
R_DECAY | >Decay Rate of Infiltration | ||
R_INFILM | Infiltration Method | Horton drying time |
For Runoff volume type set to HortonSWMM: If the value of XPX R_REGENTAG = 1, the ICM Horton drying time is imported with the value of R_REGEN; otherwise the Horton drying time is set to 7 |
R_REGENTAG | Regeneration of Horton Infiltration Capacity | ||
R_REGEN | Regeneration of Horton Infiltration Capacity Input | ||
R_INFILM | Infiltration Method | Horton max infiltration volume | For Runoff volume type set to HortonSWMM, the Horton max infiltration volume is set to the imported XPX R_MAXINF value. |
R_MAXINF | |||
R_INFILM | Infiltration Method | Green Ampt suction | For Runoff volume type set to GreenAmpt, Green Ampt suction is set to the imported XPX R_SUCT value. |
R_SUCT | Average Capillary Suction Input | ||
R_INFILM | Infiltration Method | Green Ampt conductivity | For Runoff volume type set to GreenAmpt, Green Ampt conductivity is set to the imported XPX R_HYDCON value. |
R_HYDCON | Saturated Hydraulic Conductivity Input | ||
R_INFILM | Infiltration Method | Green Ampt deficit | For Runoff volume type set to GreenAmpt, Green Ampt deficit is set to the imported XPX R_SMDMAX value. |
R_SMDMAX | Initial Moisture Deficit Input |
Build-up/wash off land use
The following fields in an XPX file are imported as a Build-up/wash off land use object in an ICM InfoWorks.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
name | Landuse name | Land use ID | |
R_CLFREQ | Cleaning interval | Sweep interval | |
R_AVSWP | Availability Factor | Sweep removal |
The value of R_AVSWP is divided by 100 on import. |
R_DSLCL | Days Since Last Cleaning | User text 1 |
RTK hydrographs
The following fields in an XPX file are imported as an RTK hydrograph object in an ICM InfoWorks network.
XPX Field |
XPX Description |
InfoWorks ICM Data Field | Notes |
---|---|---|---|
name | RTK hydrograph ID | ||
R_ST_FRACTION | Fraction of Rainfall(st) | Response ratio R - short term | |
R_ST_TIME | Time to hydrograph peak(st) | Time to peak T - short term | |
R_ST_RATIO | Ratio of base time to peak time(st) | Recession limb ratio K - short term | |
R_MT_FRACTION | Fraction of Rainfall(mt) | Response ratio R - medium term | |
R_MT_TIME | Time to hydrograph peak(mt) | Time to peak T - medium term | |
R_MT_RATIO | Ratio of base time to peak time(mt) | Recession limb ratio K - medium term | |
R_LT_FRACTION | Fraction of Rainfall(lt) | Response ratio R - long term | |
R_LT_TIME | Time to hydrograph peak(lt) | Time to peak T - long term | |
R_LT_RATIO | Ratio of base time to peak time(lt) | Recession limb ratio K - long term | |
R_ST_MAXINIT | Maximum Initial Abstraction(st) | Max initial abstraction depth - short term | |
R_ST_RECOVERY | Recovery Rate of Storage(st) | Initial abstraction recovery rate - short term | |
R_ST_STORAGE | Initial Storage(st) | Initial abstraction depth - short term | |
R_MT_MAXINIT | Maximum Initial Abstraction(mt) | Max initial abstraction depth - medium term | |
R_MT_RECOVERY | Recovery Rate of Storage(mt) | Initial abstraction recovery rate - medium term | |
R_MT_STORAGE | Initial Storage(mt) | Initial abstraction depth - medium term | |
R_LT_MAXINIT | Maximum Initial Abstraction(lt) | Max initial abstraction depth - long term | |
R_LT_RECOVERY | Recovery Rate of Storage(lt) | Initial abstraction recovery rate - long term | |
R_LT_STORAGE | Initial Storage(lt) | Initial abstraction depth - long term |
Polygons
The following fields in an XPX file are imported to the following types of Polygon objects in an ICM InfoWorks network:
Polygon
The following fields in an XPX file are imported to a Polygon type of object in an ICM InfoWorks network:
XPX Field | InfoWorks ICM Data Field | Notes |
---|---|---|
Default Area Type | Category |
Set to Void in ICM for any polygon whose Default Area Type is 'Inactive' in the XPX file. |
Set to Void in ICM for any polygon that is created as a result of importing data to a 2D zone object. See the Boundary array description for 2D Zones below. | ||
Layer Name | ID |
Applicable for data imported from LAYER in the XPX file. The format for the ID is: <Layer name>_<Layer id>_<Polyline id> |
Layer ID | ||
Polygon ID | ||
ID |
Applicable for data imported from DATA in the XPX file. The polygon ID is generated based on the XPX layer the polygon is exported from. The format of the ID is as follows:
For a polygon that is created as a result of importing data for a 2D zone object, the format for the name of the polygon is: VP_<number> where the number is sequentially increased for each polygon created. See the Boundary array description for 2D Zones below for further information. |
|
Area | Calculated by ICM using the imported boundary array data. | |
2D_REG_PNIND |
Boundary array |
Applicable for data imported from DATA in the XPX file. The geometry of the polygon. 2D_REG_PX and 2D_REG_PY store the X and Y coordinate of each point within a polygon for all the region type layers. Polygon index is the order in which the X and Y values are stored in the database. 2D_REG_PNIND stores the number of indices per polygon while 2D_REG_ PIND stores the actual indices. Imported with polygon geometry if 2D_REG_PTYPE = 0 |
2D_REG_PX |
||
2D_REG_PY | ||
2D_REG_PIND | ||
2D_REG_PTYPE | ||
2D_REG_PVAL | ||
2D_TOP_PNIND | Boundary array |
Applicable for data imported from DATA in the XPX file. The geometry of the polygon. If 2D_TOP_PVAL = 3 (filled), the '2D_TOP' fields are imported as a Mesh zone in ICM; otherwise they are imported as a Polygon. 2D_TOP_PX and 2D_TOP_PY stores all the X and Y coordinate of each point within a polygon for all the region type layers. Polygon index is the order in which the X and Y values are stored in the database. 2D_TOP_PNIND stores the number of indices per polygon while 2D_TOP_PIND stores the actual indices. Imported with polygon geometry if 2D_TOP_PTYPE = 0 |
2D_TOP_PX | ||
2D_TOP_PY | ||
2D_TOP_PIND | ||
2D_TOP_PTYPE | ||
2D_TOP_PVAL | ||
Boundary array | Applicable for a polygon that is created as a result of importing data to a 2D zone object. For further information, see the Boundary array description for 2D Zones below. | |
X,Y points | Boundary array |
Applicable for data imported from LAYER in the XPX file. |
Mesh Zone
The following fields in an XPX file are imported to a Mesh zone type of object in an ICM InfoWorks network:
XPX Field | InfoWorks ICM Data Field | Notes |
---|---|---|
Layer Name | ID |
Applicable for data imported from LAYER in the XPX file. The format for the ID is: <Layer name>_<Layer id>_<Polyline id> |
Layer ID | ||
Polygon ID | ||
ID |
Applicable for data imported from DATA in the XPX file. The ID is generated based on the XPX layer the polygon is exported from. The format of the ID is as follows:
|
|
Area | Calculated by ICM using the imported boundary array data. | |
2D_TOP_PNIND | Boundary array |
Applicable for data imported from DATA in the XPX file. If 2D_TOP_PVAL = 3 (filled), the '2D_TOP' fields are imported as a Mesh zone in ICM; otherwise they are imported as a Polygon. 2D_TOP_PX and 2D_TOP_PY stores the X and Y coordinate of each point within a polygon for all the region type layers. Polygon index is the order in which the X and Y values are stored in the database. 2D_TOP_PNIND stores the number of indices per polygon while 2D_TOP_PIND stores the actual indices. Imported with polygon geometry if 2D_TOP_PTYPE = 0 |
2D_TOP_PX | ||
2D_TOP_PY | ||
2D_TOP_PIND | ||
2D_TOP_PTYPE | ||
2D_TOP_PVAL | ||
X,Y points | Boundary array | Applicable for data imported from LAYER in the XPX file. |
Grid Step Size | Minimum element area | Only applicable to the XPX 2D_GRID_EXTENT layer type. The Minimum element area is imported as the value of the 'Grid Step Size' squared (F_2D_EXT_STEP2). |
2D Zone
The following fields in an XPX file are imported to a 2D zone type of object in an ICM InfoWorks network:
XPX Field | InfoWorks ICM Data Field | Notes |
---|---|---|
Layer Type | If the Layer Type in the XPX file is 2D_GRID_EXTENT, the data is imported to 2D zone object in ICM. | |
Default Area Type | If the XPX Default Area Type is 'Inactive', the data is imported as a 2D Zone. | |
Layer Name | ID |
Applicable for data imported from LAYER in the XPX file. The format for the ID is: <Layer name>_<Layer id>_<Polyline id> |
Layer ID | ||
Polygon ID | ||
ID |
Applicable for data imported from DATA in the XPX file. The ID is generated based on the XPSWMM/XPStorm layer the polygon is exported from. The format of the ID is as follows:
|
|
Area |
Calculated by ICM using the imported boundary array data. |
|
X,Y points | Boundary array | Applicable for data imported from LAYER in the XPX file. |
Boundary array |
Applicable for data imported from DATA in the XPX file. The geometry of the 2D zone is determined by the imported grid extents. For any area in the XPX file that is not an active area polygon (ie, the XPSWMM/XPStorm polygon's Default Area Type is set to 'Inactive'), the grid extent for the inactive area is subtracted from the active area polygon and the remaining area is imported as the 2D zone boundary array data in ICM. Note that if the result yields any holes, the holes are imported as ICM Polygon objects with their Category property set to Void |
|
Grid Step Size | Minimum element area | Only applicable to the XPX 2D_GRID_EXTENT layer type. The Minimum element area is imported as the value of the 'Grid Step Size' squared (F_2D_EXT_STEP2). |
Mesh Level Zone
The following fields in an XPX file are imported to a Mesh level zone type of object in an ICM InfoWorks network:
XPX Field | InfoWorks ICM Data Field | Notes | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Layer Name | ID |
The format for the ID is: <Layer name>_<Layer id>_<Polyline id> |
|||||||||
Layer ID | |||||||||||
Polygon ID | |||||||||||
Vertices |
The following XPX fields are imported into the Vertices Editor in ICM.
|
Roughness Zone
The following fields in an XPX file are imported to a Roughness Zone type of object in an ICM InfoWorks network:
XPX Field | InfoWorks ICM Data Field | Notes |
---|---|---|
Layer Type | If the Layer Type in the XPX file is 2D_LANDUSE, the data is imported to a Roughness zone object in ICM. | |
LanduseID | ID |
The format for the ID is: Landuse ID _ Count |
Count | ||
Area |
Calculated by ICM using the imported boundary array data. |
|
ROUGH_VAL | Roughness (Manning's n) | Imported if Manning's roughness is set to constant in the XPX file. |
2D_RGH_PNIND |
Boundary array |
Applicable for data imported from DATA in the XPX file. The geometry of the porous polygon. 2D_RGH_PX and 2D_RGH_PY store all the X and Y coordinates of each point within a polygon for all the region type layers. Polygon index is the order in which the X and Y values are stored in the database. 2D_RGH_PNIND stores the number of indices per polygon while 2D_RGH_PIND stores the actual indices. |
2D_RGH_PX |
||
2D_RGH_PY | ||
2D_RGH_PIND | ||
2D_RGH_PTYPE | Imported with polygon geometry if 2D_RGH_PTYPE = 0 | |
2D_RGH_PVAL | ||
X,Y points | Boundary array | Applicable if the Roughness zone is imported from the LAYER, POLYGONS and LAYER_DATA commands in the XPX file. |
IC Zone - Hydraulic (2D)
The following fields in an XPX file are imported to an IC zone - hydraulic (2D) type of object in an ICM InfoWorks network:
XPX Field | InfoWorks ICM Data Field | Notes |
---|---|---|
Layer Type | If the Layer Type in the XPX file is 2D_INITIAL_WATER_LEVEL, the data is imported as an IC zone - hydraulic (2D) object in ICM. | |
Layer Name | ID |
The format for the ID is: <Layer name>_<Layer id>_<Polyline id> |
Layer ID | ||
Polygon ID | ||
Area |
Calculated by ICM using the imported boundary array data. |
|
X,Y points | Boundary array |
Lines
Data from an XPX file is imported to the following type of Line object in an ICM InfoWorks network:
2D Boundary
The following fields in an XPX file are imported to a 2D Boundary type of object in an ICM InfoWorks network:
XPX Field | InfoWorks ICM Data Field | Notes |
---|---|---|
Layer name |
Name |
The format for the name is <Layer name>_<Layer id>_<Polyline id> |
Layer ID | ||
Polyline ID | ||
X,Y points | General Line XY Data | |
Layer type | Boundary line type |
If the XPSWMM/XPStorm Layer type is set to 2D_HEAD_BOUNDARY, the Boundary line type will be imported as Level in ICM. If the XPSWMM/XPStorm Layer type is set to 2D_FLOW_BOUNDARY, the Boundary line type will be imported as Flow in ICM. |